<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>MasterPage Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">MasterPage Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Base element for master pages within a report.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>MasterPage</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportElement.html">ReportElement</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Pages</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>Yes</td></tr>
<tr><td>Default Style:</td>
<td><a href="../styles.html#page">page</a></td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-bottomMargin">bottomMargin</a></dt>
<dd>The amount of white space at the bottom of each page.</dd>
<dt><a href="#Property-columnSpacing">columnSpacing</a></dt>
<dd>The amount of space between columns.</dd>
<dt><a href="#Property-columns">columns</a></dt>
<dd>The number of columns on the page</dd>
<dt><a href="#Property-height">height</a></dt>
<dd>The height of a custom-sized page.</dd>
<dt><a href="#Property-leftMargin">leftMargin</a></dt>
<dd>The amount of white space at the left side of each 
page.</dd>
<dt><a href="#Property-orientation">orientation</a></dt>
<dd>The page orientation. Portrait, Landscape or Auto 
(default).</dd>
<dt><a href="#Property-rightMargin">rightMargin</a></dt>
<dd>The amount of white space at the right side of each 
page.</dd>
<dt><a href="#Property-style">style</a></dt>
<dd>Name of the style applied to this item.</dd>
<dt><a href="#Property-topMargin">topMargin</a></dt>
<dd>The amount of white space at the top of each page.</dd>
<dt><a href="#Property-type">type</a></dt>
<dd>One of the standard page types: Custom, US Letter, US 
Legal or A4.</dd>
<dt><a href="#Property-width">width</a></dt>
<dd>The width of a page. (Set only for a custom page 
size.)</dd>
</dl>

<h3>Method Summary</h3>

<dl class="section-text">
<dt><a href="#Method-onPageEnd">onPageEnd</a></dt>
<dd></dd>
<dt><a href="#Method-onPageStart">onPageStart</a></dt>
<dd></dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>The master page is an abstract element that defines the 
basic properties of a page. The derived elements, Simple and Graphic Master 
Pages, provide content that appears on the page itself. The simple master page 
is best for use with simple reports, or reports targeted for the web. Graphic 
master pages provide a robust set of formatting capabilities and are ideal for 
sophisticated web layouts or printed reports.</p>

<p>The master page element is a kind of Report Element. Some 
of the inherited attributes have a special meaning. The Name property provides 
the name of the master page and is required. The page name must be unique within 
the design. The name is used to create a page sequence, and to associate master 
pages with report elements.</p>

<p>Master pages cannot extend another master page, and so 
the extends property is ignored.</p>

<p>The master page implicitly defines 
a content area. In a single-column report, the content area is the area inside 
the margins.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-bottomMargin">bottomMargin Property</a></h2>

<p class="section-text">The amount of white space at the bottom of each page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Bottom margin</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>0.25in</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Margin</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The amount of white space at the margins of each page. Each dimension must be 
in physical units. The dimension cannot use relative units (percent, em, or ex.) 
The size also cannot be in pixels.</p></div>

<hr>
<h2><a name="Property-columnSpacing">columnSpacing Property</a></h2>

<p class="section-text">The amount of space between columns.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Column spacing</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>12pt</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The amount of space between columns.</p></div>

<hr>
<h2><a name="Property-columns">columns Property</a></h2>

<p class="section-text">The number of columns on the page</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Columns</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>1</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The number of columns on the page. A multi-column page prints like a phone book or a dictionary: the left 
column is filled from top to bottom, then the next column, and so on until all columns are full.</p></div>

<hr>
<h2><a name="Property-height">height Property</a></h2>

<p class="section-text">The height of a custom-sized page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Height</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Required if the page type is Custom.The height of a page. (Set only for a custom page size.) 
The dimension must be in physical units. The dimension cannot use relative units 
(percent, em, or ex.) The size also cannot be in pixels.</p></div>

<hr>
<h2><a name="Property-leftMargin">leftMargin Property</a></h2>

<p class="section-text">The amount of white space at the left side of each 
page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Left margin</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>0.25in</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Margin</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The amount of white space at the margins of each page. Each dimension must be 
in physical units. The dimension cannot use relative units (percent, em, or ex.) 
The size also cannot be in pixels.</p></div>

<hr>
<h2><a name="Property-orientation">orientation Property</a></h2>

<p class="section-text">The page orientation. Portrait, Landscape or Auto 
(default).</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Orientation</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>auto</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>auto</td>
<td>Auto</td>
<td>auto</td>
<td>BIRT chooses the best 
    orientation for the report.</td></tr>
<tr><td>portrait</td>
<td>Portrait</td>
<td>portrait</td>
<td>The page is taller than 
    it is wide.</td></tr>
<tr><td>landscape</td>
<td>Landscape</td>
<td>landscape</td>
<td>The page is wider than 
    it is tall.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The page orientation. Used only if <code>
pageType</code> is set to one of the standard types; ignored if Type is set to 
Custom.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>pageType</code> Property</p></div>

<hr>
<h2><a name="Property-rightMargin">rightMargin Property</a></h2>

<p class="section-text">The amount of white space at the right side of each 
page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Right margin</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>0.25in</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Margin</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The amount of white space at the margins of each page. Each dimension must be 
in physical units. The dimension cannot use relative units (percent, em, or ex.) 
The size also cannot be in pixels.</p></div>

<hr>
<h2><a name="Property-style">style Property</a></h2>

<p class="section-text">Name of the style applied to this item.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Style.html">Style</a> Reference</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Style</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Master pages provide many style properties. The style 
properties are defined in the <i>ROM Styles Specification</i>. An element can 
inherit its style properties from a parent element (which does not apply to 
master pages), from a named style, or from a style that identifies the context 
in which the item appears. This property provides the name of the shared style 
to use.</p>

<p>This item can also set the value of style properties. 
Properties set on this element &quot;override&quot; those inherited from a parent element 
or a shared style.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Style element in the <i>ROM Styles Specification</i>.</p></div>

<hr>
<h2><a name="Property-topMargin">topMargin Property</a></h2>

<p class="section-text">The amount of white space at the top of each page.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Top margin</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>0.25in</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Margin</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The amount of white space at the margins of each page. Each dimension must be 
in physical units. The dimension cannot use relative units (percent, em, or ex.) 
The size also cannot be in pixels.</p></div>

<hr>
<h2><a name="Property-type">type Property</a></h2>

<p class="section-text">One of the standard page types: Custom, US Letter, US 
Legal or A4.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>us-letter</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>custom</td>
<td>Custom</td>
<td>custom</td>
<td>The page size is 
    user-defined.</td></tr>
<tr><td>us-letter</td>
<td>US Letter</td>
<td>us-letter</td>
<td>US letter-sized paper: 
    8.5&quot; by</span> 11&quot;.</td></tr>
<tr><td>us-legal</td>
<td>US Legal</td>
<td>us-legal</td>
<td>US legal-sized paper: 
    8.5&quot; by</span> 14&quot;.</td></tr>
<tr><td>a4</td>
<td>A4</td>
<td>a4</td>
<td>Metric A4 paper size.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>One of the standard page types: Custom, US Letter, US 
Legal or A4. (Others may be added in the future.)</p>

<p>The default is locale-dependent, usually US Letter for 
the US locale, A4 for the rest of the world. The default is set when a new page 
is created in the report designer; a page in the design file must supply a page 
type, which could however, be Custom.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>orientation</code> property</p>
<p><code>height</code> &amp;
<code>width</code> properties</p></div>

<hr>
<h2><a name="Property-width">width Property</a></h2>

<p class="section-text">The width of a page. (Set only for a custom page 
size.)</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#dimension">dimension</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Width</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Required if the page type is Custom.The width of a page. (Set only for a custom page size.) 
The dimension must be in physical units. The dimension cannot use relative units 
(percent, em, or ex.) The size also cannot be in pixels.</p></div>
<h1>Method Detail</h1>

<h2><a name="Method-onPageEnd">onPageEnd Method</a></h2>

<p class="section-text"></p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPageEnd(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>


<hr>
<h2><a name="Method-onPageStart">onPageStart Method</a></h2>

<p class="section-text"></p>
<h3>Synopsis
</h3>

<p class="section-text"><code>None&nbsp;obj.onPageStart(&nbsp;)</code></p>
<h3>Details
</h3>

<table class="detail-table">
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Context:</td>
<td>factory</td></tr>
<tr><td>Arguments:</td>
<td>None</td></tr>
<tr><td>Return Type:</td>
<td>None</td></tr>
</table>

</body>
</html>
